home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 February: Technology Seed / Mac Tech Seed Feb '97.toast / OpenDoc 1.2b2c1 / OpenDoc / Interfaces / IDL / Frame.idl < prev    next >
Encoding:
Text File  |  1997-02-13  |  4.9 KB  |  268 lines  |  [TEXT/MPS ]
  1. //#    Copyright:    © 1993 - 1995 by Apple Computer, Inc., all rights reserved.
  2.  
  3. #ifndef _FRAME_
  4. #define _FRAME_
  5.  
  6. #ifndef _PSTOBJ_
  7. #include "PstObj.idl"
  8. #endif
  9.  
  10. //==============================================================================
  11. // Classes defined in this interface
  12. //==============================================================================
  13.  
  14. interface  ODFrame;
  15.  
  16. //==============================================================================
  17. // Classes used by this interface
  18. //==============================================================================
  19.  
  20. interface  ODFrameFacetIterator;
  21.  
  22. interface  ODCanvas;
  23. interface  ODFacet;
  24. interface  ODPart;
  25. interface  ODShape;
  26. interface  ODTransform;
  27. interface  ODWindow;
  28.  
  29.  
  30.  
  31. //==============================================================================
  32. // ODFrame
  33. //==============================================================================
  34.  
  35. interface ODFrame :  ODPersistentObject
  36. {
  37.     //# containing frame
  38.  
  39.     ODFrame        AcquireContainingFrame();
  40.     
  41.     void        SetContainingFrame(in ODFrame frame);
  42.  
  43.     //# window
  44.  
  45.     ODWindow    AcquireWindow();
  46.     
  47.     void        SetWindow(in ODWindow window);
  48.  
  49.     //# getters/setters:
  50.  
  51.     ODULong        GetFrameGroup();
  52.     
  53.     void        SetFrameGroup(in ODULong groupID);
  54.  
  55.     ODULong        GetSequenceNumber();
  56.     
  57.     void        ChangeSequenceNumber(in ODULong sequenceNumber);
  58.  
  59.     ODBoolean    IsRoot();
  60.  
  61.     ODBoolean    IsSubframe();
  62.     
  63.     void        SetSubframe(in ODBoolean isSubframe);
  64.  
  65.     ODBoolean    IsOverlaid();
  66.  
  67.     ODBoolean    IsFrozen();
  68.     
  69.     void        SetFrozen(in ODBoolean isFrozen);
  70.  
  71.     ODBoolean    DoesPropagateEvents();
  72.     
  73.     void        SetPropagateEvents(in ODBoolean doesPropagateEvents);
  74.  
  75.     ODBoolean    IsInLimbo();
  76.     
  77.     void        SetInLimbo(in ODBoolean isInLimbo);
  78.  
  79.     //# part
  80.  
  81.     ODPart        AcquirePart();
  82.  
  83.     void        ChangePart(in ODPart part);
  84.  
  85.     ODInfoType    GetPartInfo();
  86.     
  87.     void        SetPartInfo(in ODInfoType partInfo);
  88.  
  89.     ODTypeToken    GetViewType();
  90.     
  91.     void        SetViewType(in ODTypeToken viewType);
  92.  
  93.     void        ChangeViewType(in ODTypeToken viewType);
  94.  
  95.     ODTypeToken    GetPresentation();
  96.     
  97.     void        SetPresentation(in ODTypeToken presentation);
  98.  
  99.     void        ChangePresentation(in ODTypeToken presentation);
  100.  
  101.     //# facets
  102.  
  103.     void        FacetAdded(in ODFacet facet);
  104.  
  105.     void        FacetRemoved(in ODFacet facet);
  106.  
  107.     ODFrameFacetIterator    CreateFacetIterator();
  108.     
  109.     //# shapes:
  110.  
  111.     ODShape        CreateShape();
  112.  
  113.     //# frame shape
  114.     
  115.     ODShape        AcquireFrameShape(in ODCanvas biasCanvas);
  116.  
  117.     void        ChangeFrameShape(in ODShape shape, in ODCanvas biasCanvas);
  118.  
  119.     ODShape        RequestFrameShape(in ODShape shape, in ODCanvas biasCanvas);
  120.  
  121.     //# used shape
  122.     
  123.     ODShape        AcquireUsedShape(in ODCanvas biasCanvas);
  124.  
  125.     void        ChangeUsedShape(in ODShape shape, in ODCanvas biasCanvas);
  126.  
  127.     //# transformations:
  128.  
  129.     ODTransform    CreateTransform();
  130.  
  131.     ODTransform    AcquireInternalTransform(in ODCanvas biasCanvas);
  132.  
  133.     void        ChangeInternalTransform(in ODTransform transform, in ODCanvas biasCanvas);
  134.     
  135.     //# content extent:
  136.  
  137.     void        GetContentExtent(out ODPoint contentExtent);
  138.     
  139.     void        ChangeContentExtent(in ODPoint contentExtent);
  140.  
  141.     //# drag&drop:
  142.  
  143.     ODBoolean    IsDroppable();
  144.  
  145.     void        SetDroppable(in ODBoolean isDroppable);
  146.  
  147.     ODBoolean    IsDragging();
  148.  
  149.     void        SetDragging(in ODBoolean isDragging);
  150.  
  151.     //# linking:
  152.  
  153.     void        ContentUpdated(in ODUpdateID change);
  154.  
  155.     void        ChangeLinkStatus(in ODLinkStatus status);
  156.  
  157.     ODLinkStatus GetLinkStatus();
  158.  
  159.     ODBoolean    EditInLink();
  160.  
  161.     //# invalidation/draw:
  162.  
  163.     void        Invalidate(in ODShape invalidShape, in ODCanvas biasCanvas);
  164.  
  165.     void        Validate(in ODShape validShape, in ODCanvas biasCanvas);
  166.  
  167.     void        InvalidateActiveBorder();
  168.  
  169.     void        DrawActiveBorder();
  170.  
  171.     //# ref counting
  172.  
  173.     void        Close();
  174.  
  175.     void        Remove();
  176.  
  177. //# Private to implementation
  178.  
  179.  
  180. #ifdef __SOMIDL__
  181.     implementation
  182.       {
  183.         majorversion = 1; minorversion = 0;
  184.     
  185.         functionprefix = ODFrame;
  186.         
  187.         override:
  188.             somUninit,
  189.             Purge,
  190.             Release,
  191.             ReleaseAll,
  192.             Externalize,
  193.             GetID,
  194.             CloneInto;
  195.             
  196.         releaseorder:
  197.             AcquireContainingFrame,
  198.             SetContainingFrame,
  199.             AcquireWindow,
  200.             SetWindow,
  201.             GetFrameGroup,
  202.             SetFrameGroup,
  203.             GetSequenceNumber,
  204.             ChangeSequenceNumber,
  205.             IsRoot,
  206.             IsSubframe,
  207.             SetSubframe,
  208.             IsOverlaid,
  209.             IsFrozen,
  210.             SetFrozen,
  211.             DoesPropagateEvents,
  212.             SetPropagateEvents,
  213.             IsInLimbo,
  214.             SetInLimbo,
  215.             AcquirePart,
  216.             ChangePart,
  217.             GetPartInfo,
  218.             SetPartInfo,
  219.             GetViewType,
  220.             SetViewType,
  221.             ChangeViewType,
  222.             GetPresentation,
  223.             SetPresentation,
  224.             ChangePresentation,
  225.             FacetAdded,
  226.             FacetRemoved,
  227.             CreateFacetIterator,
  228.             CreateShape,
  229.             AcquireFrameShape,
  230.             ChangeFrameShape,
  231.             RequestFrameShape,
  232.             AcquireUsedShape,
  233.             ChangeUsedShape,
  234.             CreateTransform,
  235.             AcquireInternalTransform,
  236.             ChangeInternalTransform,
  237.             GetContentExtent,
  238.             ChangeContentExtent,
  239.             IsDroppable,
  240.             SetDroppable,
  241.             IsDragging,
  242.             SetDragging,
  243.             ContentUpdated,
  244.             ChangeLinkStatus,
  245.             GetLinkStatus,
  246.             EditInLink,
  247.             Invalidate,
  248.             Validate,
  249.             InvalidateActiveBorder,
  250.             DrawActiveBorder,
  251.             Close,
  252.             Remove,
  253.             reserved1,
  254.             reserved2,
  255.             reserved3,
  256.             reserved4,
  257.             reserved5,
  258.             reserved6,
  259.             reserved7,
  260.             reserved8,
  261.             reserved9;
  262.             
  263.     };
  264. #endif
  265. };
  266.  
  267. #endif //# _FRAME_
  268.